\hypertarget{classsc2_1_1_unit}{}\section{sc2\+:\+:Unit Class Reference}
\label{classsc2_1_1_unit}\index{sc2\+::\+Unit@{sc2\+::\+Unit}}


A unit. Could be a structure, a worker or a military unit.  




{\ttfamily \#include $<$sc2\+\_\+unit.\+h$>$}

\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270}{Display\+Type} \{ \hyperlink{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270abd326f19234975ca23bb3265223d969d}{Visible} = 1, 
\hyperlink{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270a0e970750301873d6ee4903e9bcb8d2c6}{Snapshot} = 2, 
\hyperlink{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270a688e1743ab48c61d2e77ac6212f77cd9}{Hidden} = 3
 \}\begin{DoxyCompactList}\small\item\em If the unit is shown on screen or not. \end{DoxyCompactList}
\item 
enum \hyperlink{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461}{Alliance} \{ \hyperlink{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461af4dea1a00c973443e0d459bb522f7637}{Self} = 1, 
\hyperlink{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a2215843e5737efd34b268be16757ed27}{Ally} = 2, 
\hyperlink{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a50d778ca3f3c354474d27013b7eda3c1}{Neutral} = 3, 
\hyperlink{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a005610fbf80eaa3cc4ea28c26a42eae6}{Enemy} = 4
 \}\begin{DoxyCompactList}\small\item\em Relationship to this player. \end{DoxyCompactList}
\item 
enum \hyperlink{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943}{Cloak\+State} \{ \hyperlink{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943ac0cfb31c1521ab9e7759bfa12bf05b23}{Cloaked} = 1, 
\hyperlink{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a4d1351a1f8046904bf4b089813b610b0}{Cloaked\+Detected} = 2, 
\hyperlink{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a992a9de6738dc46b3ba64a6da9030f0f}{Not\+Cloaked} = 3, 
\hyperlink{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a2cf1dac1fc0a53735ae998f1cd437446}{Unknown} = 4
 \}\begin{DoxyCompactList}\small\item\em \hyperlink{classsc2_1_1_unit}{Unit} cloak state. \end{DoxyCompactList}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classsc2_1_1_unit_aca5722ffb5bc156d0e9d0b28a40fb7c1}\label{classsc2_1_1_unit_aca5722ffb5bc156d0e9d0b28a40fb7c1}} 
{\bfseries operator Tag} () const
\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a37330a1811b5fe37894d13d8b8f000ac}\label{classsc2_1_1_unit_a37330a1811b5fe37894d13d8b8f000ac}} 
\hyperlink{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270}{Display\+Type} \hyperlink{classsc2_1_1_unit_a37330a1811b5fe37894d13d8b8f000ac}{display\+\_\+type}
\begin{DoxyCompactList}\small\item\em If the unit is shown on screen or not. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a639d0b3495e03ee28f5e91b16057d42b}\label{classsc2_1_1_unit_a639d0b3495e03ee28f5e91b16057d42b}} 
\hyperlink{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461}{Alliance} \hyperlink{classsc2_1_1_unit_a639d0b3495e03ee28f5e91b16057d42b}{alliance}
\begin{DoxyCompactList}\small\item\em Relationship of the unit to this player. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a1312ee20e783753ee8ddf054878f7d9f}\label{classsc2_1_1_unit_a1312ee20e783753ee8ddf054878f7d9f}} 
Tag \hyperlink{classsc2_1_1_unit_a1312ee20e783753ee8ddf054878f7d9f}{tag}
\begin{DoxyCompactList}\small\item\em A unique identifier for the instance of a unit. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a4d7e26d2a7a33bc685fc3696dfed026f}\label{classsc2_1_1_unit_a4d7e26d2a7a33bc685fc3696dfed026f}} 
\hyperlink{classsc2_1_1_s_c2_type}{Unit\+Type\+ID} \hyperlink{classsc2_1_1_unit_a4d7e26d2a7a33bc685fc3696dfed026f}{unit\+\_\+type}
\begin{DoxyCompactList}\small\item\em An identifier of the type of unit. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a29fec2e9dff50d8504e8a2b32f7a1af0}\label{classsc2_1_1_unit_a29fec2e9dff50d8504e8a2b32f7a1af0}} 
int \hyperlink{classsc2_1_1_unit_a29fec2e9dff50d8504e8a2b32f7a1af0}{owner}
\begin{DoxyCompactList}\small\item\em Which player owns a unit. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_adbe75d15c90712cb1e55e8b8bcbc1319}\label{classsc2_1_1_unit_adbe75d15c90712cb1e55e8b8bcbc1319}} 
\hyperlink{structsc2_1_1_point3_d}{Point3D} \hyperlink{classsc2_1_1_unit_adbe75d15c90712cb1e55e8b8bcbc1319}{pos}
\begin{DoxyCompactList}\small\item\em Position of the unit in the world. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a9f947f6dffd571c2ab89ddd53609a7f4}\label{classsc2_1_1_unit_a9f947f6dffd571c2ab89ddd53609a7f4}} 
float \hyperlink{classsc2_1_1_unit_a9f947f6dffd571c2ab89ddd53609a7f4}{facing}
\begin{DoxyCompactList}\small\item\em Direction the unit faces in radians (1 radian == 57.\+296 degrees) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a0c2d1fb9e6f150333d96cc8ce8f9e9bf}\label{classsc2_1_1_unit_a0c2d1fb9e6f150333d96cc8ce8f9e9bf}} 
float \hyperlink{classsc2_1_1_unit_a0c2d1fb9e6f150333d96cc8ce8f9e9bf}{radius}
\begin{DoxyCompactList}\small\item\em Radius of the unit. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_abb3c46774c4d5dab4d641a4abcf68aba}\label{classsc2_1_1_unit_abb3c46774c4d5dab4d641a4abcf68aba}} 
float \hyperlink{classsc2_1_1_unit_abb3c46774c4d5dab4d641a4abcf68aba}{build\+\_\+progress}
\begin{DoxyCompactList}\small\item\em Gives progress under construction. Range\+: \mbox{[}0.\+0, 1.\+0\mbox{]}. 1.\+0 == finished. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_ad06992e99ddf45f28be06550c61fabd4}\label{classsc2_1_1_unit_ad06992e99ddf45f28be06550c61fabd4}} 
\hyperlink{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943}{Cloak\+State} \hyperlink{classsc2_1_1_unit_ad06992e99ddf45f28be06550c61fabd4}{cloak}
\begin{DoxyCompactList}\small\item\em If the unit is cloaked. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a212a848d56f8ce323c1a8b5ac7bd0221}\label{classsc2_1_1_unit_a212a848d56f8ce323c1a8b5ac7bd0221}} 
float \hyperlink{classsc2_1_1_unit_a212a848d56f8ce323c1a8b5ac7bd0221}{detect\+\_\+range}
\begin{DoxyCompactList}\small\item\em Range of detector for detector units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a22e99532761f81474b7e666e08bf8727}\label{classsc2_1_1_unit_a22e99532761f81474b7e666e08bf8727}} 
float \hyperlink{classsc2_1_1_unit_a22e99532761f81474b7e666e08bf8727}{radar\+\_\+range}
\begin{DoxyCompactList}\small\item\em Range of radar for units that are radar units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_afc532e894e9496c843ac00abce343f41}\label{classsc2_1_1_unit_afc532e894e9496c843ac00abce343f41}} 
bool \hyperlink{classsc2_1_1_unit_afc532e894e9496c843ac00abce343f41}{is\+\_\+selected}
\begin{DoxyCompactList}\small\item\em If the unit is in the current selection of the player. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a2766e02109100817ffd5135591746293}\label{classsc2_1_1_unit_a2766e02109100817ffd5135591746293}} 
bool \hyperlink{classsc2_1_1_unit_a2766e02109100817ffd5135591746293}{is\+\_\+on\+\_\+screen}
\begin{DoxyCompactList}\small\item\em Visible and within the camera frustum. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_aa730ea2bf474d4422e6c6a1e267945d4}\label{classsc2_1_1_unit_aa730ea2bf474d4422e6c6a1e267945d4}} 
bool \hyperlink{classsc2_1_1_unit_aa730ea2bf474d4422e6c6a1e267945d4}{is\+\_\+blip}
\begin{DoxyCompactList}\small\item\em Detected by sensor tower. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a7049529d7ec06419b85121a384949abf}\label{classsc2_1_1_unit_a7049529d7ec06419b85121a384949abf}} 
float \hyperlink{classsc2_1_1_unit_a7049529d7ec06419b85121a384949abf}{health}
\begin{DoxyCompactList}\small\item\em Health of the unit. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a9903ceca120d82cacc49dee00150fe67}\label{classsc2_1_1_unit_a9903ceca120d82cacc49dee00150fe67}} 
float \hyperlink{classsc2_1_1_unit_a9903ceca120d82cacc49dee00150fe67}{health\+\_\+max}
\begin{DoxyCompactList}\small\item\em Max health for the unit. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_ae5ee0c4d31a1266e31ac0a739bcc3d86}\label{classsc2_1_1_unit_ae5ee0c4d31a1266e31ac0a739bcc3d86}} 
float \hyperlink{classsc2_1_1_unit_ae5ee0c4d31a1266e31ac0a739bcc3d86}{shield}
\begin{DoxyCompactList}\small\item\em Shield of the unit. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_aa2b194b8a5499b7591356dc6365c0cdc}\label{classsc2_1_1_unit_aa2b194b8a5499b7591356dc6365c0cdc}} 
float \hyperlink{classsc2_1_1_unit_aa2b194b8a5499b7591356dc6365c0cdc}{energy}
\begin{DoxyCompactList}\small\item\em Energy of the unit. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a689d7b7c9a68b3cd172f2333203423b9}\label{classsc2_1_1_unit_a689d7b7c9a68b3cd172f2333203423b9}} 
int \hyperlink{classsc2_1_1_unit_a689d7b7c9a68b3cd172f2333203423b9}{mineral\+\_\+contents}
\begin{DoxyCompactList}\small\item\em Amount of minerals if the unit is a mineral field. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a76fcaa010a8a61b14b2839f49ef0f257}\label{classsc2_1_1_unit_a76fcaa010a8a61b14b2839f49ef0f257}} 
int \hyperlink{classsc2_1_1_unit_a76fcaa010a8a61b14b2839f49ef0f257}{vespene\+\_\+contents}
\begin{DoxyCompactList}\small\item\em Amount of vespene if the unit is a geyser. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a6480f0b177f99a656ab3a273df3f8c3c}\label{classsc2_1_1_unit_a6480f0b177f99a656ab3a273df3f8c3c}} 
bool \hyperlink{classsc2_1_1_unit_a6480f0b177f99a656ab3a273df3f8c3c}{is\+\_\+flying}
\begin{DoxyCompactList}\small\item\em If the unit is flying. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_af815cd5269616209d4a2bdf2e734decb}\label{classsc2_1_1_unit_af815cd5269616209d4a2bdf2e734decb}} 
bool \hyperlink{classsc2_1_1_unit_af815cd5269616209d4a2bdf2e734decb}{is\+\_\+burrowed}
\begin{DoxyCompactList}\small\item\em If the unit is burrowed. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a09bcc532a373b225b4ddb16fa77e9c41}\label{classsc2_1_1_unit_a09bcc532a373b225b4ddb16fa77e9c41}} 
float \hyperlink{classsc2_1_1_unit_a09bcc532a373b225b4ddb16fa77e9c41}{weapon\+\_\+cooldown}
\begin{DoxyCompactList}\small\item\em Time remaining for a weapon on cooldown. Not set for snapshots. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a45b97cf510454a385c372e512b40c51a}\label{classsc2_1_1_unit_a45b97cf510454a385c372e512b40c51a}} 
std\+::vector$<$ \hyperlink{structsc2_1_1_unit_order}{Unit\+Order} $>$ \hyperlink{classsc2_1_1_unit_a45b97cf510454a385c372e512b40c51a}{orders}
\begin{DoxyCompactList}\small\item\em Orders on a unit. Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a01b13cf74f1851983a834fdbf3e22b8a}\label{classsc2_1_1_unit_a01b13cf74f1851983a834fdbf3e22b8a}} 
Tag \hyperlink{classsc2_1_1_unit_a01b13cf74f1851983a834fdbf3e22b8a}{add\+\_\+on\+\_\+tag}
\begin{DoxyCompactList}\small\item\em Add-\/on like a tech lab or reactor. Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a01e2249c0d1bd27d8b61f233fbd75b66}\label{classsc2_1_1_unit_a01e2249c0d1bd27d8b61f233fbd75b66}} 
std\+::vector$<$ \hyperlink{structsc2_1_1_passenger_unit}{Passenger\+Unit} $>$ \hyperlink{classsc2_1_1_unit_a01e2249c0d1bd27d8b61f233fbd75b66}{passengers}
\begin{DoxyCompactList}\small\item\em Passengers in this transport. Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a59fb99084581bf4871a7de173931fc79}\label{classsc2_1_1_unit_a59fb99084581bf4871a7de173931fc79}} 
int \hyperlink{classsc2_1_1_unit_a59fb99084581bf4871a7de173931fc79}{cargo\+\_\+space\+\_\+taken}
\begin{DoxyCompactList}\small\item\em Number of cargo slots used in the transport. Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_ab5dfd5b0c6f27a8a1f89b372260d9fb2}\label{classsc2_1_1_unit_ab5dfd5b0c6f27a8a1f89b372260d9fb2}} 
int \hyperlink{classsc2_1_1_unit_ab5dfd5b0c6f27a8a1f89b372260d9fb2}{cargo\+\_\+space\+\_\+max}
\begin{DoxyCompactList}\small\item\em Number of cargo slots available for a transport. Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_aca42babe7fa2542782783a825fb99522}\label{classsc2_1_1_unit_aca42babe7fa2542782783a825fb99522}} 
int \hyperlink{classsc2_1_1_unit_aca42babe7fa2542782783a825fb99522}{assigned\+\_\+harvesters}
\begin{DoxyCompactList}\small\item\em Number of harvesters associated with a town hall (e.\+g., Command Center). Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a59c9e7c9c14f50f11d33b58716f664fe}\label{classsc2_1_1_unit_a59c9e7c9c14f50f11d33b58716f664fe}} 
int \hyperlink{classsc2_1_1_unit_a59c9e7c9c14f50f11d33b58716f664fe}{ideal\+\_\+harvesters}
\begin{DoxyCompactList}\small\item\em Number of harvesters that can be assigned to a town hall (e.\+g., Command Center). Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a0d1cc770a037ed2458bf944a787dcca5}\label{classsc2_1_1_unit_a0d1cc770a037ed2458bf944a787dcca5}} 
Tag \hyperlink{classsc2_1_1_unit_a0d1cc770a037ed2458bf944a787dcca5}{engaged\+\_\+target\+\_\+tag}
\begin{DoxyCompactList}\small\item\em Target unit of a unit. Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classsc2_1_1_unit_a34f17705c61114ad78c192ed7b06a9af}\label{classsc2_1_1_unit_a34f17705c61114ad78c192ed7b06a9af}} 
std\+::vector$<$ \hyperlink{classsc2_1_1_s_c2_type}{Buff\+ID} $>$ \hyperlink{classsc2_1_1_unit_a34f17705c61114ad78c192ed7b06a9af}{buffs}
\begin{DoxyCompactList}\small\item\em Buffs on this unit. Only valid for this player\textquotesingle{}s units. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
A unit. Could be a structure, a worker or a military unit. 

\subsection{Member Enumeration Documentation}
\mbox{\Hypertarget{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461}\label{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461}} 
\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Alliance@{Alliance}}
\index{Alliance@{Alliance}!sc2\+::\+Unit@{sc2\+::\+Unit}}
\subsubsection{\texorpdfstring{Alliance}{Alliance}}
{\footnotesize\ttfamily enum \hyperlink{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461}{sc2\+::\+Unit\+::\+Alliance}}



Relationship to this player. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{Self@{Self}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Self@{Self}}}\mbox{\Hypertarget{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461af4dea1a00c973443e0d459bb522f7637}\label{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461af4dea1a00c973443e0d459bb522f7637}} 
Self&Belongs to the player. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Ally@{Ally}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Ally@{Ally}}}\mbox{\Hypertarget{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a2215843e5737efd34b268be16757ed27}\label{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a2215843e5737efd34b268be16757ed27}} 
Ally&Ally of the player. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Neutral@{Neutral}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Neutral@{Neutral}}}\mbox{\Hypertarget{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a50d778ca3f3c354474d27013b7eda3c1}\label{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a50d778ca3f3c354474d27013b7eda3c1}} 
Neutral&A neutral unit, usually a non-\/player unit like a mineral field. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Enemy@{Enemy}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Enemy@{Enemy}}}\mbox{\Hypertarget{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a005610fbf80eaa3cc4ea28c26a42eae6}\label{classsc2_1_1_unit_a5a40e672e7599d73ef8ef5758bbd7461a005610fbf80eaa3cc4ea28c26a42eae6}} 
Enemy&Enemy of the player. \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943}\label{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943}} 
\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Cloak\+State@{Cloak\+State}}
\index{Cloak\+State@{Cloak\+State}!sc2\+::\+Unit@{sc2\+::\+Unit}}
\subsubsection{\texorpdfstring{Cloak\+State}{CloakState}}
{\footnotesize\ttfamily enum \hyperlink{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943}{sc2\+::\+Unit\+::\+Cloak\+State}}



\hyperlink{classsc2_1_1_unit}{Unit} cloak state. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{Cloaked@{Cloaked}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Cloaked@{Cloaked}}}\mbox{\Hypertarget{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943ac0cfb31c1521ab9e7759bfa12bf05b23}\label{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943ac0cfb31c1521ab9e7759bfa12bf05b23}} 
Cloaked&Cloaked, invisible to enemies until detected. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Cloaked\+Detected@{Cloaked\+Detected}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Cloaked\+Detected@{Cloaked\+Detected}}}\mbox{\Hypertarget{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a4d1351a1f8046904bf4b089813b610b0}\label{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a4d1351a1f8046904bf4b089813b610b0}} 
Cloaked\+Detected&Cloaked enemy, but detected. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Not\+Cloaked@{Not\+Cloaked}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Not\+Cloaked@{Not\+Cloaked}}}\mbox{\Hypertarget{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a992a9de6738dc46b3ba64a6da9030f0f}\label{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a992a9de6738dc46b3ba64a6da9030f0f}} 
Not\+Cloaked&No cloaking. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Unknown@{Unknown}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Unknown@{Unknown}}}\mbox{\Hypertarget{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a2cf1dac1fc0a53735ae998f1cd437446}\label{classsc2_1_1_unit_a03f99cfaa8ad4f9bba6cd0bc5586c943a2cf1dac1fc0a53735ae998f1cd437446}} 
Unknown&Could not determine cloaking state. \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270}\label{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270}} 
\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Display\+Type@{Display\+Type}}
\index{Display\+Type@{Display\+Type}!sc2\+::\+Unit@{sc2\+::\+Unit}}
\subsubsection{\texorpdfstring{Display\+Type}{DisplayType}}
{\footnotesize\ttfamily enum \hyperlink{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270}{sc2\+::\+Unit\+::\+Display\+Type}}



If the unit is shown on screen or not. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{Visible@{Visible}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Visible@{Visible}}}\mbox{\Hypertarget{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270abd326f19234975ca23bb3265223d969d}\label{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270abd326f19234975ca23bb3265223d969d}} 
Visible&\hyperlink{classsc2_1_1_unit}{Unit} will be visible. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Snapshot@{Snapshot}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Snapshot@{Snapshot}}}\mbox{\Hypertarget{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270a0e970750301873d6ee4903e9bcb8d2c6}\label{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270a0e970750301873d6ee4903e9bcb8d2c6}} 
Snapshot&\hyperlink{classsc2_1_1_unit}{Unit} is represented by a snapshot in the fog-\/of-\/war. This is for units that don\textquotesingle{}t belong to the player. The actual unit may be in a different location or state. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{Hidden@{Hidden}!sc2\+::\+Unit@{sc2\+::\+Unit}}\index{sc2\+::\+Unit@{sc2\+::\+Unit}!Hidden@{Hidden}}}\mbox{\Hypertarget{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270a688e1743ab48c61d2e77ac6212f77cd9}\label{classsc2_1_1_unit_af7815dad89107a05298c245b702ab270a688e1743ab48c61d2e77ac6212f77cd9}} 
Hidden&\hyperlink{classsc2_1_1_unit}{Unit} will be hidden to enemies. \\
\hline

\end{DoxyEnumFields}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
include/sc2api/\hyperlink{sc2__unit_8h}{sc2\+\_\+unit.\+h}\end{DoxyCompactItemize}
